home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / pcboard / acnfn28.zip / ACNFN.DOC < prev    next >
Text File  |  1996-02-15  |  15KB  |  377 lines
  1.                Automated Network/Conference Listing Generator
  2.  
  3.                                   v2.8
  4.  
  5.                           PCBoard 14.5/15.x
  6.  
  7.                                    by
  8.  
  9.                               Al Lawrence
  10.  
  11.                             Sunrise-80  BBS
  12.                   
  13.                   (404) 256-9525 (USR v.everything 28.8)
  14.                   (404) 705-9104 (USR v.everything 28.8)
  15.                   (404) 256-9518 (Voice, 9am-9:30pm EST)
  16.                      (E-MAIL) al_lawre@ix.netcom.com
  17.  
  18.  
  19.  
  20.  
  21.                               DESCRIPTION
  22.                               ___________
  23.  
  24.  
  25. The Automated Network/Conference Listing Generator (ACNFN) is a utility that 
  26. creates the conference display file. Most Sysops use an editor to create the 
  27. conference listing, more commonly called CNFN. As you add/change/delete 
  28. conferences you end up spending hours trying to realign and colorize the 
  29. display. If you happen to add a whole network, you could very well spend more 
  30. time fixing the conference listing, than creating the conferences themselves. 
  31. This utility does not create any extraneous files on disk and uses the CNAMES 
  32. file as input. There is no need to create a second file for the colorized 
  33. listing, as the program uses the @X variables made available in PCBoard 
  34. v14.5/15.x  Just about everything is configurable, from verbage to colors.
  35.  
  36.  
  37.  
  38.  
  39.                          R E S T R I C T I O N S
  40.                          -----------------------
  41.  
  42. In the UNREGISTERED version of ACNFN, ALL conferences will be PROCESSED, but 
  43. only the first 50 conferences will be displayed.
  44.  
  45.  
  46.  
  47.                               INSTALLATION
  48.                               ____________
  49.  
  50.  
  51.    Installation is fairly easy and straight-forward. The following steps and
  52.    examples should have you up and running in a very short period of time.
  53.  
  54.      (1) Create a Configuration file named ACNFN.CFG
  55.  
  56.      (2) Run the program using the following command line:
  57.  
  58.                        ACNFN  
  59.  
  60.  
  61.  
  62.  
  63.                              CONFIGURATION FILE
  64.                              __________________
  65.  
  66.      Line 1.   Sunrise-80 BBS
  67.      Line 2.   Al Lawrence
  68.      Line 3.   00000000
  69.      Line 4.   INPUT=C:\PCB\MAIN\CNAMES
  70.      Line 5.   OUTPUT=C:\PCB\GEN\CNFN
  71.      Line 6.   SORT=N
  72.      Line 7.   NUMCOL=LEFT
  73.      LINE 8.   NDESC=RIM:RIME
  74.      Line 9.   NETCONF=RIM:2:100:P
  75.      Line 10.  CONF=LOC:Sunrise Doors:1:1:p
  76.      Line 11.  XCNF=@X06
  77.      Line 12.  XTYP=@X0C
  78.      Line 13.  XCFN=@X0A
  79.      Line 14.  XHDB=@X1A
  80.      Line 15.  XBBS=@X1F
  81.      Line 16.  XNET=@X57
  82.      Line 17.  XBBG=@X1F
  83.      Line 18.  XMRE=@X8C
  84.      Line 19.  BLINE=R = Restricted
  85.      Line 20.  COLUMNS=4
  86.      Line 21.  SEPCNFN=N
  87.  
  88.  
  89. __________________________________________________________________________
  90.  
  91. Line 1.  Your BBS Name. Will Display on Heading and is mandatory
  92.  
  93. Line 2.  Sysop's First and Last Name. Does not display, but is mandatory.
  94.  
  95. Line 3.  Registration Number
  96.  
  97. Line 4.  Full Pathname\Filename of the CNAMES file. This entry is
  98.          mandatory.
  99.  
  100. Line 5.  Full Pathname\Filename of the output file that will contain
  101.          the conference listing. This entry is mandatory.
  102.  
  103. Line 6.  This entry indicates the SORT sequence for the conference displays.
  104.          N = Display conference's in conference NUMBER sequence.
  105.          A = Display conference's in conference NAME sequence.
  106.          This entry is mandatory.
  107.  
  108. Line 7.  This entry indicates where you would like to have the conference
  109.          number displayed.
  110.          LEFT  = Display it to the LEFT  of the conference name
  111.          RIGHT = Display it to the RIGHT of the conference name.
  112.          This entry is mandatory.
  113.  
  114. Line 8.  This entry assigns a UNIQUE 3 character ID and description to each
  115.          Network on your system. The format is|  NETWORK ID:NETWORK NAME
  116.          The Network name will appear in the header, displayed at the top of
  117.          each column of the listing for that network. One NDESC entry is
  118.          required for EACH Network you carry. The maximum size of the Network
  119.          Name is 17 characters. The program will support a maximum of 99
  120.          Networks. At least one is mandatory
  121.  
  122. Line 9.  This entry describes the conference numbers to be associated with
  123.          each of the conference descriptions you have defined above. At
  124.          least one is mandatory.
  125.  
  126.          Format|  NETWORK ID:STARTING CONF. #:ENDING CONF. #:CONF. TYPE
  127.          NETWORK ID = Must match one of the IDs in line 8.
  128.          STARTING # = First conference # in a range comprising the network
  129.          ENDING   # = Last  conference # in a range comprising the network
  130.          CONF. TYPE = P for Public Conferences, R for Restricted/Reserved or
  131.                       F for conferences that contain files
  132.                       Note: This applies to ALL the conference numbers in the
  133.                             range indicated.
  134.  
  135.          Use multiple NETCONF entries if you have a mixture of Public and
  136.          Reserved. For example: if your RIME conferences covered numbers
  137.          1-100 and #35-37 were Reserved and all others were Public you would
  138.          use 3 NETCONF entries. 1-34 would have a CONF TYPE of P, 35-37 would
  139.          have a CONF TYPE of R and 38-100 would have a CONF TYPE of P. You can
  140.          use any number of NETCONF entries to fully describe your conference
  141.          to a maximum of 500 !
  142.  
  143. Line 10. This entry is used to assign a conference to more than one NETWORK.
  144.          This is mostly cosmetic and is NOT a required entry. In future
  145.          versions this entry will be used by non-PCBoard systems. Optional.
  146.          Format| NETWORK ID:CON. NAME:CONF. #:CONF. TYPE
  147.          NETWORK ID = Must match one of the IDs in line 8.
  148.          CON. NAME  = Conference name up to a maximum of 12 characters
  149.          CONF. #    = Conference number up 3 digits
  150.          CONF. TYPE = Same as Line 9 above
  151.  
  152. -------------------------------------------------------------------------
  153. --- Next 8 Entries Control the Colors For Each Section of the Listing ---
  154. ---------------------- Uses @X Color Codes ------------------------------
  155. -------------------- Registered Version Only ----------------------------
  156. -------------------------------------------------------------------------
  157.  
  158. Line 11. Conference Name Color
  159. Line 12. Conference Type Color
  160. Line 13. Conference Number Color
  161. Line 14. Heading Color (box)
  162. Line 15. Heading BBS Name Color
  163. Line 16. Network Name Color
  164. Line 17. Bottom Line Color
  165. Line 18. "More" Color, on Bottom line (both ends)
  166.  
  167. Line 19. With this entry you can define what appears on the bottom line.
  168.          By default it will show "R = Restricted", in registered version.
  169.          Maximum length is 70 characters. Optional. Requires Registration!
  170.  
  171. Line 20. This entry will allow you to define the number of columns to be
  172.          used to display the conferences. Your choices are 1 - 4. If you
  173.          define 4 columns and the program determines that you have more than
  174.          9,999 conferences, the number of columns will be reduced to 3.
  175.  
  176. Line 21. This entry will allow you create separate CNFN files for each
  177.          network you have defined. The file name for each of the CNFN files
  178.          will be the same as the 3 character network ID you assigned in the
  179.          NETCONF lines above. In addition to the individual CNFN files an all
  180.          encompassing  CNFN will also be created.
  181.  
  182.  
  183. __________________________ E X A M P L E ____________________________________
  184. To help make all this a little clearer (it is really very simple), I will
  185. describe the conferences/Networks of my BBS and what the Configuration file
  186. would look like. Sunrise-80 BBS has 4 Networks and Local conferences. The
  187. Networks are RIME, City2City, SmartNet and L&Lnet. Conference numbers are
  188. assigned as follows:
  189.  
  190.            Rime     : 2-23, 25-70, 94 (all are Public except 29,30,35)
  191.            City2City: 73-93 (all are Public except 75,84,86)
  192.            FidoNet  : 1, 71-72, 95-97 (all are Public)
  193.            SmartNet : 98-112 (all are Public)
  194.            Local    : 0, 24 (all are Public)
  195.  
  196. In addition I display my Sunrise Doors conference (conf # 1) in Local area
  197. as well as the FidoNet Network.
  198.  
  199. I also use all the default colors and a special bottom line. All has been
  200. included in the example CFG.
  201.  
  202. The ACNFN.CFG file would look like this:
  203. _______________________________________
  204.  
  205. Sunrise-80 BBS
  206. Al Lawrence
  207. 00000000
  208. INPUT=C:\PCB\MAIN\CNAMES
  209. OUTPUT=C:\PCB\GEN\CNFN
  210. SORT=N
  211. NUMCOL=LEFT
  212. NDESC=100:R I M E
  213. NDESC=200:City2City
  214. NDESC=400:FidoNet
  215. NDESC=300:SmartNet
  216. NDESC=500:L O C A L
  217. NETCONF=200:73:74:P
  218. NETCONF=200:75:75:r
  219. NETCONF=200:76:83:p
  220. NETCONF=200:84:84:r
  221. NETCONF=200:85:85:p
  222. NETCONF=200:86:86:r
  223. NETCONF=200:87:93:p
  224. NETCONF=100:2:23:p
  225. NETCONF=100:25:28:p
  226. NETCONF=100:29:30:r
  227. NETCONF=100:31:34:p
  228. NETCONF=100:35:35:r
  229. NETCONF=100:36:70:p
  230. NETCONF=100:94:94:p
  231. NETCONF=400:1:1:p
  232. NETCONF=400:71:72:p
  233. NETCONF=400:95:97:p
  234. NETCONF=500:0:0:p
  235. NETCONF=500:24:24:p
  236. NETCONF=300:98:112:P
  237. CONF=500:Sunrise Doors:1:p
  238. XCNF=@X06
  239. XTYP=@X07
  240. XCFN=@X0A
  241. XHDB=@X1A
  242. XBBS=@X1F
  243. XNET=@X57
  244. XBBG=@X1F
  245. XMRE=@X8C
  246. BLINE=R = Restricted    [AVAILABLE FROM: Sunrise Doors/Utility Software]
  247. COLUMNS=4
  248.  
  249.  
  250.                         Hints/Tips/Other Ramblings
  251.                         __________________________
  252.  
  253.      (1) The sequence in which the networks appear, is controlled by the
  254.          NETWORK ID field. The program will sort on this field, therefore
  255.          it is important to assign values to each network that will place
  256.          them in the proper sequence. As you can see from the Example
  257.          Sunrise CFG file, above, I use 3 digit numbers.
  258.  
  259.      (2) The first three(3) entries in the CFG file are required to be in
  260.          that sequence. All others may be in any sequence.
  261.  
  262.      (3) This version will handle up to 99,999 conferences (NON-Registered
  263.          only handle 50).
  264.  
  265.      (4) Be sure to use the ':' to separate fields within each Entry.
  266.  
  267.      (5) I really do not like to do documentation and therefore there may be
  268.          some errors or omissions in this document. I would appreciate any
  269.          feedback you wish to give relative to the program itself or the Docs.
  270.  
  271.  
  272.  
  273.  
  274.                           TROUBLESHOOTING
  275.                           ---------------
  276.  
  277. (1) If you are running this Door on a 486 system and encounter errors such as
  278.  
  279.     ERROR 6.... OVERFLOW Error
  280.     ERROR 5.... ILLEGAL Function Call (may be associated with other problems)
  281.     KEYBOARD Timeout after 5 minutes
  282.  
  283.     You may have to put the following line in your AUTOEXEC.BAT file:
  284.  
  285.          SET NO87=ON
  286.  
  287. (2) If you encounter an Error 62 (Input Past End of File), BEFORE you see the
  288.     opening screen of the Door, your problem will more than likely be associated
  289.     with the CFG file. The error 62 means that you do not have enough entries
  290.     in the CFG. Compare your CFG file with the CFG definition in the DOC file.
  291.  
  292.  
  293. (3) If you encounter an ERROR 70... Permission Denied, this will more than
  294.     likely mean that you DO NOT have SHARE loaded. SHARE is a DOS file that
  295.     comes with your version of DOS. To load it type the word SHARE at the DOS
  296.     prompt. To load it permanently type the word SHARE on a line by itself in
  297.     your AUTOEXEC.BAT file, any place prior to the loading of your BBS
  298.     software. There have been numerous reports that loading SHARE high causes
  299.     some problems, so to be on the safe side, do not load it high.
  300.  
  301.  
  302. Should you have any questions or problem, please do not hesitate to call
  303.    voice for immediate help... 404-256-9518 (9am-9:30pm EST) any day!
  304.  
  305.  
  306.  
  307.  
  308.                               LEGALITIES
  309.                               __________
  310.  
  311.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  312.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  313.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  314.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  315.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  316.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  317.       OR BREACH OF ANY WARRANTY.
  318.  
  319.  
  320.  
  321.  
  322.  
  323.                              DISTRIBUTION
  324.                              ____________
  325.  
  326.    You may make this file available for downloading from your BBS or you may
  327.    upload it to any BBS of your choice, provided that you do not make any
  328.    changes to the contents of the archive (ZIP file). The archive and its
  329.    individual contents may not be used by any service that charges any money
  330.    whatsoever, without the written permission of the author.
  331.  
  332.  
  333.  
  334.  
  335.  
  336.                              REGISTRATION
  337.                              ____________
  338.  
  339.    Registration and the subsequent insertion of the registration number into
  340.    your configuation file, allows for the display of your BBS name on the
  341.    opening screenand its display in the heading of the listing, reduction of
  342.    delays, and the ability to change certain values in the configuration file.
  343.  
  344.    To register your copy of ACNFN, please fill out the registration form
  345.    (REGISTER.FRM) and mail it along with the registration fee to the name and
  346.    address on the form.
  347.  
  348.    Once a door is registered, any changes to registration information (Sysop
  349.    name or BBS Name) will require the doors to be re-registered. Download or
  350.    File Request a file named CHANGE.FRM from our BBS, complete the form and
  351.    follow ALL instructions in the document!
  352.  
  353.    Registration fees are subject to change at any time. The most current
  354.    registration form is always available on our BBS. You may download or
  355.    File Request REGISTER.FRM at any time.
  356.  
  357.    Be sure to use the proper upper/lower case when filling in your name and
  358.    BBS name, as they MUST match the way you entered them in the configuration
  359.    file.             ^^^^
  360.  
  361.    Based upon information supplied on the registration form, I will pre-
  362.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  363.    up your registration number.
  364.  
  365.  
  366.  
  367.                                  MISC
  368.                                  ____
  369.  
  370.    The latest version of ACNFN and other fine SUNRISE DOOR programs are
  371.    always available for download from SUNRISE-80 BBS.
  372.  
  373.    Remember, should you have any problems, questions or suggestions, be sure
  374.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
  375.    PCBHints, SYSops), SmartNet (SN_Sysops), City2City, FIDO (Sysops,
  376.    PCBnet, Sysop18), DoorNet or GeniusNet
  377.